/*
 * Copyright (C) 2000 - 2024 Silverpeas
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * As a special exception to the terms and conditions of version 3.0 of
 * the GPL, you may redistribute this Program in connection with Free/Libre
 * Open Source Software ("FLOSS") applications as described in Silverpeas's
 * FLOSS exception.  You should have received a copy of the text describing
 * the FLOSS exception, and it is also available here:
 * "https://www.silverpeas.org/legal/floss_exception.html"
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
package org.silverpeas.core.template;

import java.util.Map;

public interface SilverpeasTemplate {
  String TEMPLATE_ROOT_DIR = "template.root.dir";
  String TEMPLATE_CUSTOM_DIR = "template.customer.dir";

  /**
   * When the result of string template processing is built from a combination of several
   * template files, this method MUST be called BEFORE calling {@link #applyFileTemplate(String)}.
   * <p>
   * It is in charge of merging the templates given by the product and the one modified by the
   * customer. By this way, the customer modifies only the necessary templates in case of
   * customization.
   * </p>
   * @return itself.
   */
  SilverpeasTemplate mergeRootWithCustom();

  void setAttribute(String name, Object value);

  String applyFileTemplate(String fileName);

  String applyFileTemplateOnComponent(String componentName, String fileName);

  boolean isCustomTemplateExists(String componentName, String fileName);

  String applyStringTemplate(String label);

  Map<String, Object> getAttributes();
}